| PRPM_HD986010ON Provider Person Search Query |
(Link to Excel View) Derived from RMIM: PRPM_RM986010ON |
||||||||
| ParameterList | |||||||||
| address [0..1] (Address) |
Design Comments: Address in relation to the roleClass being queried upon. Rationale: Supports the business requirement to identify the specified roleClass being queried upon. |
||||||||
| administrativeGender [0..1] (AdministrativeGender) |
Design Comments: This is the gender of the person for which the query is searching. A maximum of one gender may be provided. Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| alternateIdentifier [0..1] (AlternateIdentifier) | |||||||||
| languageOption [0..1] (LanguageOption) | |||||||||
| licenseNumber [0..1] (LicenseNumber) | |||||||||
| professionStatusCode [0..1] (ProfessionStatusCode) | |||||||||
| providerFirstName [0..1] (ProviderFirstName) | |||||||||
| providerLanguageCode [0..1] (ProviderLanguageCode) | |||||||||
| providerLastName [0..1] (ProviderLastName) |
Design Comments: Name in relation to the roleClass being queried upon Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| providerPersonID [0..1] (ProviderPersonID) |
Design Comments: This is the identifier for the provider for which the query is searching. Multiple ids can be specified through repetition of this parameter. Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| providerRoleProfession [0..1] (ProviderRoleProfession) |
Design Comments: This parameter is constrained to values from the HealthCareProviderRoleType Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| providerRoleSpecialty [0..1] (ProviderRoleSpecialty) |
Design Comments: This parameter is constrained to values from the QualifiedEntityRoleType. Rationale: Supports the business requirement to identify the specified expertise or credential roleClass being queried upon. |
||||||||
| searchOption [1..1] (SearchOption) | |||||||||
| Address |
Design Comments: Address in relation to the roleClass being queried upon. Rationale: Supports the business requirement to identify the specified roleClass being queried upon. |
||||||||
| value [1..1] (M) ParameterItem (AD.SEARCH) |
Design Comments: The address of the provider when playing the role of healthcare provider. UsageNotes: Only city is allowed as an address parameter in this release. The search is also done on alternate city names, e.g. Toronto/North York/Willowdale. Rationale: Mandatory attribute supports the identification of the healthcare provider. |
||||||||
| AdministrativeGender |
Design Comments: This is the gender of the person for which the query is searching. A maximum of one gender may be provided. Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:AdministrativeGender} |
Design Comments: The principal person’s gender. Rationale: Mandatory attribute supports the identification of the healthcare provider |
||||||||
| AlternateIdentifier | |||||||||
| value [1..1] (M) ParameterItem (II.PUBLIC) |
Design Comments: Indicates an identifier (other than the UPI and provider Role License Number) assign to the Provider Person. E.g. Stakeholder Number (SN) assigned to the provider record by CPDB. Rationale: Allows for the identification of providers by secondary identification numbers. |
||||||||
| LanguageOption | |||||||||
| value [0..1] ParameterItem (CV) {CNE:D:DisplayLanguage} |
Design Comments: Indicates the language in which the requester wishes to receive the response of the query. Rationale: Allows a requester to determine the preferred official language for the requested information. |
||||||||
| LicenseNumber | |||||||||
| value [1..1] (M) ParameterItem (ST) {CWE:D:QueryParameterValue} |
Design Comments: Provider’s License Number |
||||||||
| ProfessionStatusCode | |||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:V:RoleStatus} |
Design Comments: Provider’s Profession Status Code |
||||||||
| ProviderFirstName | |||||||||
| value [1..1] (M) ParameterItem (PN.BASIC) |
Design Comments: The provider’s first name pertaining to the specific healthcare provider role. UsageNotes: Search Type: Begins With Rationale: Mandatory attribute supports the identification of the healthcare provider |
||||||||
| ProviderLanguageCode | |||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:HumanLanguage} |
Design Comments: The code identifying the language supported by the provider for communication and/or service delivery purposes. Rationale: For Search Provider Person By Name or By Profession, this combines search parameters 'official language' and 'spoken language' into one parameter. |
||||||||
| ProviderLastName [Constraint: " Only 'Family' name may be specified. "] |
Design Comments: Name in relation to the roleClass being queried upon Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (PN.BASIC) |
Design Comments: The provider’s last name pertaining to the specific healthcare provider role. UsageNotes: Search Type: Begins With Rationale: Mandatory attribute supports the identification of the healthcare provider |
||||||||
| ProviderPersonID [Constraint: " No other parameter item must be specified, if this parameter item is specified. "] |
Design Comments: This is the identifier for the provider for which the query is searching. Multiple ids can be specified through repetition of this parameter. Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (II.PUBLIC) |
Design Comments: A unique identifier for a provider in a specific healthcare role. UsageNotes: use="BUS" root="2.16.840.1.113883.3.239.9” extension="(UPI)" displayable="true". (UPI) must be 12 digits in length and must pass validation. Rationale: Mandatory attribute supports the identification of the healthcare provider |
||||||||
| ProviderRoleProfession |
Design Comments: This parameter is constrained to values from the HealthCareProviderRoleType Rationale: Supports the business requirement to identify the specified roleClass being queried upon |
||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:HealthcareProviderRoleType} |
Design Comments: The code identifying the specific healthcare provider role. Rationale: Mandatory attribute supports the identification of the healthcare provider |
||||||||
| ProviderRoleSpecialty |
Design Comments: This parameter is constrained to values from the QualifiedEntityRoleType. Rationale: Supports the business requirement to identify the specified expertise or credential roleClass being queried upon. |
||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:QualifiedExpertiseType} |
Design Comments: The code identifying the specific healthcare provider specialty. Rationale: Mandatory attribute supports the identification of the healthcare provider. |
||||||||
| SearchOption | |||||||||
| value [1..1] (M) ParameterItem (CV) {CWE:D:ProviderPersonSearchOptionType} |
Design Comments: Indicates the type of provider person search. Valid codes are: 1 - search by name 2 - search by profession 3 - search by Alt ID 4 - search by UPI Rationale: Allows for transmitting search pattern to the back-end to indicate required action |
||||||||